GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| take |
Number of notes to retrieve. Default is all notes |
integer |
None. |
| skip |
Number of notes to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the notes before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"NoteId": "b643fdff-0810-44c0-90cf-516870c3fcb3",
"Asset": {
"AssetId": "71658ad8-6472-4366-aaa0-0afe47c90b84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d692ab07-31ce-40e1-adf2-d02277e579f8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8aa3b806-558f-432c-b865-7608f5d6e94b",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "73a88669-471e-41ef-8480-09c90250e73d",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"StateType": {
"StateTypeId": "4d02ff5d-8e34-411a-acd5-f5f2dc1dbfe1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f07f221a-c353-4aa9-9370-36e45f6163e0",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cbbc6117-e1a9-4009-81b9-9b9cc564b5d4",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c5cb1dc8-f604-41a9-b693-74abc66e8fe8",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"StatusType": {
"StatusTypeId": "07d872c1-dc3f-421d-b8d0-7585ba00b424",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "06740446-3db8-48db-85d2-1c1d1cda47a4",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a0145fc-cd23-4fa1-9192-143fb5418878",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "17ac11b3-67ff-4af0-8aea-2309b402626e",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b59f5707-3bef-4459-9170-74ee8e04d7a1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed142206-58e5-493d-b8a6-f6a18fabfc1c",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "707c30c3-377b-4ca7-9008-d25fc18e0f80",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6e7a3a84-f46a-43e7-b09a-a8416190bec2",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1c4c5170-113e-49e2-82bd-b783f0abd838",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9617a8a5-d5b9-4c13-8e31-a737780c9431",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b518749d-1f50-4501-9dce-dbdadb59e37a",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 5"
},
{
"NoteId": "b643fdff-0810-44c0-90cf-516870c3fcb3",
"Asset": {
"AssetId": "71658ad8-6472-4366-aaa0-0afe47c90b84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d692ab07-31ce-40e1-adf2-d02277e579f8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8aa3b806-558f-432c-b865-7608f5d6e94b",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "73a88669-471e-41ef-8480-09c90250e73d",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"StateType": {
"StateTypeId": "4d02ff5d-8e34-411a-acd5-f5f2dc1dbfe1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f07f221a-c353-4aa9-9370-36e45f6163e0",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cbbc6117-e1a9-4009-81b9-9b9cc564b5d4",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c5cb1dc8-f604-41a9-b693-74abc66e8fe8",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"StatusType": {
"StatusTypeId": "07d872c1-dc3f-421d-b8d0-7585ba00b424",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d49f5c3f-7e1a-4c41-8ee6-ad073b704dae",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "4439f283-ff79-466b-b83e-80a931c941ac",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "06740446-3db8-48db-85d2-1c1d1cda47a4",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6a0145fc-cd23-4fa1-9192-143fb5418878",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "17ac11b3-67ff-4af0-8aea-2309b402626e",
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "b59f5707-3bef-4459-9170-74ee8e04d7a1",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ed142206-58e5-493d-b8a6-f6a18fabfc1c",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "707c30c3-377b-4ca7-9008-d25fc18e0f80",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"MeasurementValueNeededDate": "2024-04-28T16:47:48.3319817-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6e7a3a84-f46a-43e7-b09a-a8416190bec2",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1c4c5170-113e-49e2-82bd-b783f0abd838",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9617a8a5-d5b9-4c13-8e31-a737780c9431",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-04-28T16:47:48.3319817-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b518749d-1f50-4501-9dce-dbdadb59e37a",
"CreateDate": "2024-04-28T16:47:48.3319817-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-04-28T16:47:48.3319817-07:00",
"LastModifiedUser": "sample string 5"
}
],
"Total": 1,
"Message": "sample string 1"
}